/*
 * Copyright (c) 2012, marco.tamburelli@gmail.com
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met: 
 * 
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer. 
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution. 
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.bmi.gwt.mi.client.events;

import org.bmi.gwt.mi.client.channel.Connection;

/**
 * Provides methods to handle connection event and exceptions caused by errors
 * or unexpected behaviors during connection.
 * 
 * Any Mi based application requires an implementation of this class to be
 * applied to a connection. All code making use of queue features, or in
 * particular all the code requiring the Web Socked connection must be executed
 * within {@link #onConnectionBegin(Connection)} method.
 * 
 * @author marco.tamburelli@gmail.com
 */
public interface ConnectionHandler
{
	/**
	 * Method executed when the web socket establishes a connection with the
	 * sever.
	 * 
	 * Any part of code requiring connection (like queue operations) must be
	 * within the implementation of this method.
	 * 
	 * @param connection Useful reference to the {@link Connection} object
	 *        firing this event.
	 */
	void onConnectionBegin(Connection connection);

	/**
	 * Fired when an exception somewhere was raised and caught.
	 * 
	 * @param e A caught exception.
	 */
	void onException(Exception e);
}
